Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

multiple cleanups in docs #425

Merged
merged 1 commit into from
Oct 29, 2020
Merged

Conversation

hbagdi
Copy link
Contributor

@hbagdi hbagdi commented Oct 27, 2020

  • consolidate personas in a single doc
  • add a new guides page which will refer to getting started guides and
    provide cookbooks; removed cookbookmd and userguide.md as part of this
    change
  • re-wrote the intro page to better guide new users
  • nav corrections and updates based on above changes

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Oct 27, 2020
Copy link
Member

@robscott robscott left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are some awesome improvements, thanks for taking them on!

Comment on lines 25 to 35

There are 3 primary roles in the API:

- Infrastructure provider
- Cluster Operator
- Application Developer

There could be a fourth a role of Application Admin in some use cases.

Please refer to [roles and personas](concepts.md#roles-and-personas) section
in API concepts for details.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for cleaning up the duplication between this and the API concepts pages. I'm actually wondering if we should switch these around though. This PR adds all the detail around roles to the API concepts page and leaves a short summary here - maybe the short summary should be in API concepts and the detailed overview should be here. Either way, it's better to not have the full detail in both places, so thanks for fixing that.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SGTM. I've updated to switch this around.

Comment on lines 9 to 11
- Infrastructure provider
- Cluster Operator
- Application Developer
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tiny nit - capitalization doesn't match on Infrastructure Provider

docs-src/concepts.md Outdated Show resolved Hide resolved
docs-src/concepts.md Outdated Show resolved Hide resolved
docs-src/concepts.md Outdated Show resolved Hide resolved
@robscott
Copy link
Member

Some great improvements here, just had a few tiny nits.

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: hbagdi, robscott

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 28, 2020
- consolidate personas in a single doc
- add a new guides page which will refer to getting started guides and
provide cookbooks; removed cookbookmd and userguide.md as part of this
change
- re-wrote the intro page to better guide new users
- nav corrections and updates based on above changes

Co-authored-by: Rob Scott <[email protected]>
@robscott
Copy link
Member

Thanks!

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 29, 2020
@k8s-ci-robot k8s-ci-robot merged commit 3a64ac7 into kubernetes-sigs:master Oct 29, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants